home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 028a / pkinsv65.zip / PKINSERT.DOC < prev    next >
Text File  |  1991-10-22  |  31KB  |  961 lines
  1.  
  2.  
  3.  
  4.  
  5.                    ┌───────────────────────────────────────┐
  6.                    │                                       │
  7.                    │                                       │
  8.                    │                                       │
  9.                    │                                       │
  10.                    │                                       │
  11.                    │                                       │
  12.                    │                                       │
  13.                    │                                       │
  14.                    │                                       │
  15.                    │                                       │
  16.                    │            P K I N S E R T            │
  17.                    │              Version 6.5              │
  18.                    │                                       │
  19.                    │   Copyright 7th Illusion, 1990-1991   │
  20.                    │          All Rights Reserved          │
  21.                    │      Released October 22nd, 1991      │
  22.                    │                                       │
  23.                    │            F R E E W A R E            │
  24.                    │                                       │
  25.                    │                                       │
  26.                    │                                       │
  27.                    │                                       │
  28.                    │                                       │
  29.                    │                                       │
  30.                    │         Software Documentation        │
  31.                    │                                       │
  32.                    │                                       │
  33.                    │                                       │
  34.                    │                                       │
  35.                    │                                       │
  36.                    │                                       │
  37.                    │              7th Illusion             │
  38.                    │          Post Office Box 1334         │
  39.                    │               Station H               │
  40.                    │        Montreal, Quebec, Canada       │
  41.                    │                H3G 2N6                │
  42.                    │                                       │
  43.                    │                                       │
  44.                    │         Node 1  (514)338-1193         │
  45.                    │    USRobotics Courier HST 14400 Bps   │
  46.                    │        1:167/281.0@Fidonet.Org        │
  47.                    │                                       │
  48.                    │         Node 2  (514)338-1680         │
  49.                    │        GVC Super Modem 2400 Bps       │
  50.                    │                                       │
  51.                    │                                       │
  52.                    │                                       │
  53.                    │                                       │
  54.                    │                                       │
  55.                    │                                       │
  56.                    │                                       │
  57.                    │                                       │
  58.                    └───────────────────────────────────────┘
  59.  
  60.      
  61.  
  62.      PKinsert Software Documentation                          Page 1  of 15
  63.  
  64.  
  65.                                   Introduction
  66.  
  67.      Pkinsert is  an archive manipulation  utility designed  for SysOps and
  68.      end users.  It can  be configured to test  archive integrity, scan for
  69.      viruses, insert and delete disclaimer files within Zip archives, etc.
  70.  
  71.      Pkinsert is  fully network  compatible and when  used as  a Bbs upload
  72.      monitor, can create all the result files a SysOp may need.
  73.  
  74.      Released as Freeware, there's no need to register and all features are
  75.      active.   I'm  well  aware  of the  eternal  struggle  SysOps  face in
  76.      registering just a small portion of  the software they use. :-)   I'll
  77.      answer questions and work in most  features you suggest, just drop off
  78.      a message on my system.
  79.  
  80.      If  you use  Pkinsert and  have  authored SysOp  or Telecommunications
  81.      oriented software,  I would  appreciate if you  uploaded me  a copy in
  82.      return.   Please   don't  bother  with   Crippleware  or  unregistered
  83.      Shareware.
  84.  
  85.      Supplemental  information  on  installing  Pkinsert  with  PCBoard  is
  86.      available from the PkinsPCB.Doc file.
  87.  
  88.  
  89.                                                       J.S. Morisset
  90.                                                       aka Storm Widow
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.      
  121.  
  122.      PKinsert Software Documentation                          Page 2  of 15
  123.  
  124.  
  125.                                 Acknowledgements
  126.  
  127.      The  following  names are  either  trademarks,  registered trademarks,
  128.      and/or efforts of the person and/or company named.
  129.  
  130.      PCBoard            Clark Development Company
  131.      Pkzip/Pkunzip      PKWare Inc.
  132.      SCAN               McAfee Associates
  133.  
  134.                                    Upgrading
  135.  
  136.      Although you may simply 'drop-in' the new Pkinsert.Exe file, I suggest
  137.      you run  the configuration module  to take advantage  of version 6.5's
  138.      new  features.   The first  time  you re-configure  Pkinsert,  it will
  139.      compensate  for any  missing values.   On exit,  a proper  version 6.5
  140.      configuration file will be created.
  141.  
  142.      If you  are upgrading from  a version prior  to 6.0, you  will have to
  143.      start from scratch.
  144.  
  145.      Please review  the PkinsHis.Doc file  for details on  new features and
  146.      bug fixes.
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.      
  181.  
  182.      PKinsert Software Documentation                          Page 3  of 15
  183.  
  184.  
  185.                               Pkinsert Parameters
  186.  
  187.      Parameters  may  be  entered  from   the  command  line  or  using  an
  188.      environment variable.  Environment  variable parameters will over-ride
  189.      those  of the  configuration file,  and  command line  parameters will
  190.      over-ride those of the environment.  Both the environment variable and
  191.      command line parameters  are limited to 128  characters as dictated by
  192.      Dos.  Parameters are not case sensitive.
  193.  
  194.      Parameter
  195.  
  196.      /C       Marks  Pkinserts  configuration  file  name  and  path.  This
  197.               variable must be  present in the  environment or command line
  198.               for Pkinsert to load successfully.
  199.  
  200.                    ie.  /CD:\Arc\Pkinsert\Pkinsert.cfg
  201.  
  202.      /D       Pcboard  upload  description  file name  and  path.   Used to
  203.               document test failures.  (optional)
  204.  
  205.                    ie.  /DD:\Pcb\Work\Uldesc.1
  206.                         /D%3
  207.  
  208.      /L       Path and file name for standard log file.  (optional)
  209.  
  210.                    ie.  /LC:\Arc\Node3.Log
  211.  
  212.      /N       Network node  number.  Maximum length  of three alpha-numeric
  213.               characters.  (optional)
  214.  
  215.                    ie.  /Na1
  216.  
  217.      /S       Version of Scan  you are currently  using.  Maximum length of
  218.               six alpha-numeric characters.  (optional)
  219.  
  220.                    ie.  /S7.9v84
  221.  
  222.      /CONFIG  Load Pkinserts configuration module.
  223.  
  224.                    ie.  /CPkinsert.Cfg /CONFIG
  225.  
  226.      /TEST    Re-test an archive.  Affects verbose  log file results when a
  227.               virus is located.  (optional)
  228.  
  229.                    ie.  /TEST
  230.  
  231.      /UPLOAD  Process an upload.   Affects verbose log  file results when a
  232.               virus is located.  (optional)
  233.  
  234.                    ie.  /UPLOAD
  235.  
  236.  
  237.  
  238.  
  239.  
  240.      
  241.  
  242.      PKinsert Software Documentation                          Page 4  of 15
  243.  
  244.  
  245.                               Configuration Module
  246.  
  247.      To configure Pkinsert for the first time, follow this first example.
  248.  
  249.               PKINSERT.EXE /CONFIG /CC:\Pkinsert\Pkinsert.Cfg
  250.  
  251.      Pkinsert will ask you to verify the path and name of the configuration
  252.      file to create.  Pressing the (Esc) key will get you back to Dos.
  253.      
  254.      Note -   It  is  possible  to  use  a  single  configuration  file for
  255.               multiple  users/work  stations using  command  line parameter
  256.               over-rides.
  257.  
  258.      From the main configuration menu you will have three choices available
  259.      to you.  We will start from the  first and explain every item as we go
  260.      along.  All standard editing keys are active.
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.      
  301.  
  302.      PKinsert Software Documentation                          Page 5  of 15
  303.  
  304.  
  305.      ╔════════════════════════════════════════════════════════════════════╗
  306.      ║                            Options Menu                            ║
  307.      ║                                                                    ║
  308.      ║   Network Node Number     : 0       Rename Bad/Virused Zips : Y    ║
  309.      ║   Network Retry Attempts  : 4       Insert Archive Comment  : N    ║
  310.      ║   Unzip/Temp Files Drive  : D       Delete Disclaimer(s)    : N    ║
  311.      ║   Req Xtract Space (%Zip) : 250     Add File(s) to Archive  : N    ║
  312.      ║   Test Archive CRC        : Y       Manage Pass/Fail Log    : N    ║
  313.      ║   Corrupt Zip Rename Ext  : BAD     Keep Result/Error Log   : Y    ║
  314.      ║   Scan Archives for Virii : N       Max. Standard Log Size  : 80   ║
  315.      ║   McAfee Assoc. SCAN Ver  : 0.0V00  Nested Zip Array Size   : 3    ║
  316.      ║   Virused Zip Rename Ext  : VIR     Zip Wildcard Array Size : 60   ║
  317.      ║   Held Archive Rename Ext : HLD     Number Taglines to Keep : 10   ║
  318.      ║                                                                    ║
  319.      ║    Identification Tagline?                                         ║
  320.      ║    System Tagline.                                                 ║
  321.      ║                                                                    ║
  322.      ╚═══ 00/00/00 ════════════════════════════════════════ 00:00:00am ═══╝
  323.  
  324.  
  325.                               Network Node Number
  326.  
  327.      This value can be blank or from one to three alpha-numeric characters.
  328.      It may be over-ridden by a command line or environment parameter.  The
  329.      node  number  will  be  used   to  create  Pkinserts  work  directory.
  330.      Networking  and Multitasking  environments are  detected automatically
  331.      and record locking will be used when possible.
  332.  
  333.      You'll notice Pkinsert uses random  work directory names.  If two work
  334.      stations  accidentally use  the same  node number,  it is  unlikely to
  335.      cause problems.
  336.  
  337.                              Network Retry Attempts
  338.  
  339.      When Pkinsert tries to open/read/write/etc  a file which is already in
  340.      use by another user, it will  pause for 5 seconds before trying again.
  341.      This value will  dictate how many times  Pkinsert cycles.  If Pkinsert
  342.      fails, it will attempt to continue when possible, or terminate with an
  343.      error level (or rename the file).
  344.  
  345.                              Unzip/Temp Files Drive
  346.  
  347.      Enter  the  drive  letter where  Pkinsert  will  extract  archives for
  348.      testing and virus scanning.  I would suggest a ram-disk which improves
  349.      Pkinserts performance.
  350.  
  351.                             Req Xtract Space (%Zip)
  352.  
  353.      Pkinsert  will  check  for  available  disk  space  before  extracting
  354.      archives.   This value  is  not calculated  like  tax.  250%  would be
  355.      translated to 2.5 times the size of the archive.  If Pkinsert runs out
  356.      of disk space  during processing, it  will rename the  archive or exit
  357.      with an error level.
  358.  
  359.  
  360.      
  361.  
  362.      PKinsert Software Documentation                          Page 6  of 15
  363.  
  364.  
  365.      Disk space  errors are  also reported  during archive  extraction, but
  366.      verifying disk space before-hand saves time.
  367.  
  368.                                 Test Archive CRC
  369.  
  370.      Before  handling  an  archive,  Pkinsert  calls  Pkunzip  to  test the
  371.      archive.  Nested archives are also tested.
  372.  
  373.                              Corrupt Zip Rename Ext
  374.  
  375.      If you choose to  have archives renamed (that  option is a bit further
  376.      down), Pkinsert will use this file extension to rename damaged zips.
  377.  
  378.                             Scan Archives for Virii
  379.  
  380.      Pkinsert can use Scan.Exe from McAfee Associates to check archives for
  381.      viral infection.  Although archives are  expanded to check for viruses
  382.      it is unlikely you will 'catch' anything.  Virii which can be archived
  383.      attach themselves to executable code.   The files extracted are Scaned
  384.      and  never executed.   I've  successfully tested  this  option several
  385.      times with the Jerusalem Version B and 1701/1704 Version B viruses.  I
  386.      would have tested others but virus code isn't widely available.
  387.  
  388.                              McAfee Assoc. SCAN Ver
  389.  
  390.      As of this writing the current  version of scan is 7.9V84.  This field
  391.      can be blank.   If you enter a  value here it will  be used in several
  392.      display  files where  mention  of Scan  is  made.  A  command  line or
  393.      environment parameter may be used to over-ride this value.
  394.  
  395.                              Virused Zip Rename Ext
  396.  
  397.      If  a  virus  is  detected the  archive  will  be  renamed  using this
  398.      extension (provided renaming is enabled).
  399.  
  400.                             Rename Bad/Virused Zips
  401.  
  402.      This encompasses more than just file naming.  If this option is set to
  403.      'Yes'  Pkinsert will  rename archives  using  the file  extensions you
  404.      entered  above.  It  also  assumes you  are  processing archives  on a
  405.      wildcard  such  as '*.Zip'.   When  Pkinsert  runs across  a  virus or
  406.      corrupt  archive it  will rename  the  file and  continue to  the next
  407.      archive in the batch.   This method is not  very selective.  Any error
  408.      reported by Pkzip/unzip or Scan will lead to an archive being renamed.
  409.      These  problems  could   be  caused  by   a  virus,  corrupt  archive,
  410.      insufficient disk space, memory, etc.
  411.  
  412.      On the other hand  of you have elected not  to rename archives you can
  413.      do  your  own  error checking  when  Pkinsert  exits  using errorlevel
  414.      statements  in a  batch  file.  The  complete  list of  Pkinsert error
  415.      levels is  available in  appendix A.   Pkinsert must  exit immediately
  416.      after an  error occurs  so this  option should  not be  used for batch
  417.      processing.
  418.  
  419.  
  420.      
  421.  
  422.      PKinsert Software Documentation                          Page 7  of 15
  423.  
  424.  
  425.                              Insert Archive Comment
  426.  
  427.      Archives created by Pkzip give us the opportunity to insert an archive
  428.      comment screen.  If you  elect to use this  option, create a Dos Ascii
  429.      file which contains your drawing.
  430.  
  431.                               Delete Disclaimer(s)
  432.  
  433.      Certain  files,  such  as  !History.Dis  are  well  known  to  contain
  434.      advertisements or  disclaimer blurbs.  You  may elect  to delete these
  435.      files automatically  from each  archive Pkinsert  processes.  A sample
  436.      list is included within this archive  which you can edit from the next
  437.      configuration screen.
  438.  
  439.                              Add File(s) to Archive
  440.  
  441.      Same principle as above except this option lets you add files to every
  442.      archive.   I could  go on  for hours  on  the reason  not to  use this
  443.      feature, including the fact that  you are polluting archives, but I'll
  444.      leave it to your better judgment.
  445.  
  446.                               Manage Pass/Fail Log
  447.  
  448.      Aside from loging results, Pkinsert can also create one of two verbose
  449.      log files for every session.  These text files could then be displayed
  450.      to the user.  The names for these files can be specified later on.
  451.  
  452.      In order to properly link with  other utilities which use this type of
  453.      result  logging, special  handling is  necessary.  Before  appending a
  454.      Failure report, Pkinsert  will rename the  Pass Log (if  it exists) to
  455.      the Fail Log name.  Therefore an  archive could pass a series of tests
  456.      before calling  Pkinsert and  still keep  those results  when Pkinsert
  457.      fails the archive.
  458.  
  459.      If an  Extended Fail  Log already  exists, it  will be  used to append
  460.      Pkinserts Pass or Fail  reports.  In this way  an archive could Fail a
  461.      series of tests, pass  Pkinserts tests, and overall  you would be left
  462.      with one Fail log file.
  463.  
  464.                              Keep Result/Error Log
  465.  
  466.      This is a standard log file.  I would suggest you keep this option set
  467.      to 'Yes'.  It's maintenance free thanks to the following option.
  468.  
  469.                              Max. Standard Log Size
  470.  
  471.      Before every  session Pkinsert  checks the size  of it's  log.  If the
  472.      size exceeds this value (in Kb), a new one is started.
  473.  
  474.                              Nested Zip Array Size
  475.  
  476.      When Pkinsert is hunting down archives within archives (add infinitum)
  477.      it monitors it's  depth or how  'nested' it is.   During this activity
  478.      Pkinsert also keeps  track of file  names and locations  to know which
  479.  
  480.      
  481.  
  482.      PKinsert Software Documentation                          Page 8  of 15
  483.  
  484.  
  485.      archives it has followed  to the end, and  which haven't been checked.
  486.      Dos machines being what  they are, you only  get so much memory.  This
  487.      value specifies at what point  Pkinsert should start shedding portions
  488.      of itself to disk.  When it comes back from the 'deep' it will pick up
  489.      these pieces again and process the archives it missed.
  490.  
  491.      You can experiment and see what value  you prefer.  3 or 4 is probably
  492.      best.  You don't see  nesting past three very  often.  The larger this
  493.      value is, the more memory Pkinsert will need.
  494.  
  495.      Note -   Reading swapped information may  take a few moments depending
  496.               on the  size of your  wildcard array, system  and disk access
  497.               speeds.
  498.  
  499.                             Zip Wildcard Array Size
  500.  
  501.      This value determines the maximum  number of archives a nested archive
  502.      may contain.   Theoretically the wildcard  array could be  set for 999
  503.      (max tested was 600),  but this would chew up  tons of memory and disk
  504.      swapping would be excruciatingly slow.
  505.  
  506.      I've tried to  calculate the maximum  number of archives  a single Zip
  507.      could hold,  but I gave  up when I  hit 9  to the power  of 302.  That
  508.      value corresponded to a wildcard array of 101.
  509.  
  510.      Unfortunately, this value  also applies to the  wildcards you enter on
  511.      the command  line.  Therefore  '*.Zip' could  not exceed  the wildcard
  512.      array size.  An error level on exit is set if it does.
  513.  
  514.      Wildcards can be avoided easily.  See the 'Using Pkinsert' section for
  515.      details.
  516.  
  517.                             Number Taglines to Keep
  518.  
  519.      A  Tagline  is added  to  each archive  comment  containing Pkinsert's
  520.      version number and your personalized information.  Taglines from other
  521.      systems may be kept and appended  to your archive comment.  This value
  522.      determines the maximum  number of past  Taglines to keep.   A value of
  523.      zero may be used to disable this feature.
  524.  
  525.      Note -   The  Test,  Scan, or  Delete  functions must  be  enabled for
  526.               Pkinsert to pick up the Tagline information.
  527.  
  528.                             Identification Tagline?
  529.  
  530.      Your  personalized Tagline.   Usually this  includes your  BBS's name,
  531.      phone number,  and special  system features.   As the  archive travels
  532.      through various systems, your tagline  will remain within the 'Tagline
  533.      History' (providing other systems keep previous Taglines).
  534.  
  535.      Once a system tagline  has been embedded into  the archive comment, it
  536.      is still possible to  alter it slightly.  Pkinsert  does not take into
  537.      account case,  spacing, or  any non  alpha-numeric character.  Adding,
  538.      erasing, or  changing the  positions of  alpha-numeric characters will
  539.  
  540.      
  541.  
  542.      PKinsert Software Documentation                          Page 9  of 15
  543.  
  544.  
  545.      cause your old  tagline to be used  in the Tagline  History bloc if an
  546.      archive is re-processed.
  547.  
  548.      Note -   A Tagline environment  variable may be  used to over-ride the
  549.               configuration file value.
  550.  
  551.               ie.  SET TAGLINE=7th Illusion Telecommunication Services
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.      
  601.  
  602.      PKinsert Software Documentation                          Page 10 of 15
  603.  
  604.  
  605.      ╔════════════════════════════════════════════════════════════════════╗
  606.      ║                         File Location Menu                         ║
  607.      ║                                                                    ║
  608.      ║   Ascii Editor            : D:\QEDIT\Q.EXE                         ║
  609.      ║   Standard Log File       : D:\PKINSERT\PKINSERT.LOG               ║
  610.      ║   Extended Pass Log File  : PCBPASS.TXT                            ║
  611.      ║   Extended Fail Log File  : PCBFAIL.TXT                            ║
  612.      ║   Virus Comment (Test)    : D:\PKINSERT\VIRUSTST.CMT               ║
  613.      ║   Virus Comment (Upload)  : D:\PKINSERT\VIRUSULD.CMT               ║
  614.      ║   Archive Comment File    : D:\PKINSERT\PKINSERT.CMT               ║
  615.      ║   Disclaimer(s) Del List  : D:\PKINSERT\PKINSDEL.LST               ║
  616.      ║   Add File(s) List        : D:\PKINSERT\PKINSADD.LST               ║
  617.      ║                                                                    ║
  618.      ╚═══ 00/00/00 ════════════════════════════════════════ 00:00:00am ═══╝
  619.  
  620.  
  621.                                   Ascii Editor
  622.  
  623.      Ascii editor name and path.  Placing the cursor on a line which can be
  624.      edited, a bar will appear at the bottom of the screen informing you to
  625.      press F2 to edit the file.
  626.  
  627.                                Standard Log File
  628.  
  629.      Path and name of the Standard log file.  This value can be over-ridden
  630.      by using the '/L' environment or command line parameter.
  631.  
  632.                         Extended Pass and Fail Log Files
  633.  
  634.      If the  'Manage Pass/Fail  Log' option  (1st configuration  screen) is
  635.      enabled, these file names are used to report processing results.
  636.  
  637.                        Virus Comment (Test) and (Upload)
  638.  
  639.      These two text files are used when Pkinsert has created the Failed Log
  640.      File above, and *only* in cases when a virus is found.
  641.  
  642.      The contents  of (Test)  are added  to the  Fail log  when the '/TEST'
  643.      parameter is used.   SysOps could use  this file to  advise users they
  644.      should leave a  Comment to the  SysOp a.s.a.p. so  this archive may be
  645.      deleted.
  646.  
  647.      Similarly, the contents of (Upload) are added to the Fail log when the
  648.      '/UPLOAD' parameter  is used.   This second  text file  could advise a
  649.      user that  his system  might be  contaminated and  to take appropriate
  650.      steps before uploading again.
  651.  
  652.      If these files do not exist they will not be used.  This way you could
  653.      have a comment for one function and not the other.
  654.  
  655.                               Archive Comment File
  656.  
  657.      This file should contain your archive comment (Ascii drawing).  Enable
  658.      this feature from the Configuration Options menu.
  659.  
  660.      
  661.  
  662.      PKinsert Software Documentation                          Page 11 of 15
  663.  
  664.  
  665.  
  666.                              Disclaimer(s) Del List
  667.  
  668.      This list is  used when the 'Delete  Disclaimer(s)' option is enabled.
  669.      A single  filespec should be  entered on each  line.  Archive contents
  670.      will be compared to this list and matching files will be deleted.
  671.  
  672.                                 Add File(s) List
  673.  
  674.      Same principal as above, this file  should contain a list of filespecs
  675.      to insert in every  archive.  Unlike the delete  list you must include
  676.      paths for each file.
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.      
  721.  
  722.      PKinsert Software Documentation                          Page 12 of 15
  723.  
  724.  
  725.      ╔════════════════════════════════════════════════════════════════════╗
  726.      ║                    Command Line Parameters Menu                    ║
  727.      ║                                                                    ║
  728.      ║   Pkunzip Test Archive    : /t                                     ║
  729.      ║   Pkunzip Extract Files   : /xn /ojhsr                             ║
  730.      ║   McAfee Associates SCAN  : /a /nobreak /nomem /nopause /sub       ║
  731.      ║   Pkzip Del Disclaimer(s) : /dk                                    ║
  732.      ║   Pkzip Add Files/Comment : /exzk                                  ║
  733.      ║                                                                    ║
  734.      ╚═══ 00/00/00 ════════════════════════════════════════ 00:00:00am ═══╝
  735.  
  736.  
  737.      These parameters are  passed by Pkinsert when  shelling to third party
  738.      software.  If you encounter problems  with a new parameter set, please
  739.      drop me a line so I  can adjust Pkinsert accordingly.  The options for
  740.      Scan  have been  tested  with version  7.9V84  and may  not  work with
  741.      earlier versions.
  742.  
  743.                               Pkzip Work File Path
  744.  
  745.      When Pkzip handles an archive, it  creates a .!!! temporary work file.
  746.      If you have  a ram-disk installed,  you should edit  the above command
  747.      line parameters instructing Pkzip to use the faster drive.
  748.  
  749.          ie.  Pkzip Del Disclaimer(s) : /dk /bF:\
  750.               Pkzip Add Files/Comment : /exzk /bF:\
  751.  
  752.                                  Date Stamping
  753.  
  754.      Using the  'k' parameter, Pkzip  will NOT  change the file  date of an
  755.      archive.  An 'o'  will set the  archive date to  the oldest file found
  756.      within the archive.  Eliminating these  date parameters will cause the
  757.      archive date to be updated to the current one.
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.      
  781.  
  782.      PKinsert Software Documentation                          Page 13 of 15
  783.  
  784.  
  785.                                  Using Pkinsert
  786.  
  787.      Using Pkinsert is fairly simple.  From the command line or environment
  788.      variable make  sure Pkinsert  knows where  to find  it's configuration
  789.      file.  Then call Pkinsert passing it file names (or wildcards).
  790.  
  791.      The parameters, file names,  etc can be in  any order.  You could even
  792.      enter file names through the environment variable if you wanted.  Some
  793.      examples follow.
  794.  
  795.          ie.  SET PKINSERT=/N1 /S7.8v82
  796.               PKINSERT %1 *.Zip /CD:\Pkinsert\Pkinsert.Cfg *.Exe Abc-?.New
  797.  
  798.               SET PKINSERT=/CC:\Pkinsert\System.Cfg
  799.               PKINSERT *.Zip *.Exe Abc.Bak
  800.  
  801.               SET PKINSERT=/N1 /SVer82 Archive.Zip /C\Arc\Config.Pki
  802.               PKINSERT
  803.  
  804.               PKINSERT /CPkins.Cnf Test.Zip
  805.  
  806.      Undoubtedly most users will want  to test complete directories at some
  807.      point, which  may exceed  the Wildcard Array  size.  In  this case, an
  808.      advanced Dos command line could be used.
  809.  
  810.          ie.  LOOP.BAT
  811.               ~~~~~~~~
  812.               FOR %%A IN (*.Zip) DO PKINSERT %%A
  813.               or
  814.               FOR %%A IN (A*.Zip Dbl*.* Abc-?.Zip) DO PKINSERT %%A
  815.  
  816.      Any filename preceded with an '@' symbol will be expected to contain a
  817.      list of files to  process.  Each file specification  in this list must
  818.      occupy a separate line.  Wildcarding is accepted.
  819.  
  820.          ie.  Files.Lst
  821.               ~~~~~~~~~
  822.               D:\Arc\*.Zip
  823.               Archive.Zip
  824.               E:\Main\Files\Backup.Z??
  825.               \Work\A*.Tmp
  826.  
  827.          You may also use a combination of directory pipes.
  828.  
  829.          ie.  C:\>Dir D:\Arc >>Files.Lst
  830.               C:\>Dir E:\Main\Files\*.Zip >>Files.Lst
  831.  
  832.          Instead of entering  redundant directory information  you can tell
  833.          Pkinsert to change  drives and directories.   Use the 'Cd' command
  834.          followed by a space, or back-slash, and the directory name.
  835.  
  836.          ie.  Files.Lst
  837.               ~~~~~~~~~
  838.               Archive.Zip
  839.  
  840.      
  841.  
  842.      PKinsert Software Documentation                          Page 14 of 15
  843.  
  844.  
  845.               Cd\Arc
  846.               *.Zip
  847.               Cd E:\Main\Files
  848.               Good*.Zip
  849.               Bad*.Old
  850.               Ugly*.$$$
  851.               Cd\C:\Temp
  852.               Backup.Z??
  853.  
  854.          These techniques can be used together for greatest versatility.
  855.  
  856.          Note -    Normal  array size  boundaries  apply ONLY  to wildcards
  857.                    within this  list.  There is  NO LIMIT to  the number of
  858.                    filespecs contained  in the  file list.   If you  have a
  859.                    directory of several  thousand archives you  could use a
  860.                    command sequence along these lines:
  861.  
  862.                    C:\>Dir J:\Uploads\*.Zip >>Files.Lst
  863.                    C:\>Pkinsert @*.Lst
  864.  
  865.                    Wildcarding is also acceptable for filelist names.
  866.  
  867.  
  868.  
  869.  
  870.  
  871.  
  872.  
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.      
  901.  
  902.      PKinsert Software Documentation                          Page 15 of 15
  903.  
  904.  
  905.                                    Appendix A
  906.                               Pkinsert Exit Codes
  907.  
  908.           Virus Scan
  909.  
  910.      10   One or More Virii Found
  911.      11   Abnormal Termination
  912.           (Usually Lack of Memory)
  913.  
  914.           Pkunzip
  915.  
  916.      20   Zip Failed CRC Check
  917.      21   Error in Zip File
  918.      22   Insufficient Memory
  919.      23   Archive File Missing
  920.      24   Illegal Parameters Specified
  921.      25   No Files in Archive to Test
  922.      26   Disk Full
  923.      27   Unexpected EOF in Zip
  924.  
  925.           Pkzip
  926.  
  927.      40   Bad File Name or File Specification
  928.      41   Error in Zip File
  929.      42   Insufficient Memory
  930.      43   No Files Found To Delete
  931.      44   File Not Found
  932.      45   Disk Full
  933.      46   Archive Is Read-Only - Cannot Modify
  934.      47   Bad or Illegal Parameters
  935.      48   Too Many Files in Zip
  936.  
  937.           Pkinsert
  938.  
  939.      100  Incorrect Parameters
  940.      101  Configuration File Missing
  941.      103  Unable To Create Work Directory
  942.      104  Invalid Path or No Matching Files
  943.      105  Insufficient Drive Space Available
  944.      106  Unable To Remove Work Directory
  945.      107  Insufficient DOS File Handles
  946.      108  Network Delay Timed-Out
  947.      109  Unable to Remove Nest Directories
  948.      110  Illegal Configuration File Value
  949.      111  Illegal Compression Method Used
  950.      112  Zero Byte File
  951.      113  Unknown Configuration File Format
  952.      114  Unable to Locate File; Pkzip/Unzip or Scan
  953.      200  Wildcard Array Exceeded
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960.      
  961.